-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
definitions.json
5561 lines (5561 loc) · 178 KB
/
definitions.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"version": "2019-12-01-preview",
"description": "A spec file containing all the definitions",
"title": "Definitions file"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {},
"definitions": {
"AccessInformationContract": {
"properties": {
"id": {
"type": "string",
"description": "Identifier."
},
"primaryKey": {
"type": "string",
"description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value."
},
"secondaryKey": {
"type": "string",
"description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value."
},
"enabled": {
"type": "boolean",
"description": "Determines whether direct access is enabled."
}
},
"description": "Tenant access information contract of the API Management service."
},
"AccessInformationUpdateParameters": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/AccessInformationUpdateParameterProperties",
"description": "Tenant access information update parameter properties."
}
},
"description": "Tenant access information update parameters."
},
"AccessInformationUpdateParameterProperties": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Determines whether direct access is enabled."
}
},
"description": "Tenant access information update parameters of the API Management service"
},
"ApiCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiContract"
},
"description": "Page values.",
"readOnly": true
},
"nextLink": {
"type": "string",
"description": "Next page link if any.",
"readOnly": true
}
},
"description": "Paged Api list representation."
},
"ApiContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ApiContractProperties",
"description": "Api entity contract properties."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "Api details."
},
"ApiContractProperties": {
"properties": {
"sourceApiId": {
"type": "string",
"description": "API identifier of the source API."
},
"displayName": {
"type": "string",
"description": "API name. Must be 1 to 300 characters long.",
"minLength": 1,
"maxLength": 300
},
"serviceUrl": {
"type": "string",
"description": "Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.",
"minLength": 0,
"maxLength": 2000
},
"path": {
"type": "string",
"description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.",
"minLength": 0,
"maxLength": 400
},
"protocols": {
"type": "array",
"items": {
"type": "string",
"enum": [
"http",
"https"
],
"x-ms-enum": {
"name": "Protocol",
"modelAsString": false
}
},
"description": "Describes on which protocols the operations in this API can be invoked."
},
"apiVersionSet": {
"description": "Version set details",
"$ref": "#/definitions/ApiVersionSetContractDetails"
}
},
"allOf": [
{
"$ref": "#/definitions/ApiEntityBaseContract"
}
],
"required": [
"path"
],
"description": "Api Entity Properties"
},
"ApiCreateOrUpdateParameter": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ApiCreateOrUpdateProperties",
"description": "Api entity create of update properties."
}
},
"description": "API Create or Update Parameters."
},
"ApiCreateOrUpdateProperties": {
"properties": {
"value": {
"type": "string",
"description": "Content value when Importing an API."
},
"format": {
"type": "string",
"description": "Format of the Content in which the API is getting imported.",
"enum": [
"wadl-xml",
"wadl-link-json",
"swagger-json",
"swagger-link-json",
"wsdl",
"wsdl-link",
"openapi",
"openapi+json",
"openapi-link",
"openapi+json-link"
],
"x-ms-enum": {
"name": "ContentFormat",
"modelAsString": true,
"values": [
{
"value": "wadl-xml",
"description": "The contents are inline and Content type is a WADL document."
},
{
"value": "wadl-link-json",
"description": "The WADL document is hosted on a publicly accessible internet address."
},
{
"value": "swagger-json",
"description": "The contents are inline and Content Type is a OpenApi 2.0 Document."
},
{
"value": "swagger-link-json",
"description": "The Open Api 2.0 document is hosted on a publicly accessible internet address."
},
{
"value": "wsdl",
"description": "The contents are inline and the document is a WSDL/Soap document."
},
{
"value": "wsdl-link",
"description": "The WSDL document is hosted on a publicly accessible internet address."
},
{
"value": "openapi",
"description": "The contents are inline and Content Type is a OpenApi 3.0 Document in YAML format."
},
{
"value": "openapi+json",
"description": "The contents are inline and Content Type is a OpenApi 3.0 Document in JSON format."
},
{
"value": "openapi-link",
"description": "The Open Api 3.0 document is hosted on a publicly accessible internet address."
},
{
"value": "openapi+json-link",
"description": "The Open Api 3.0 Json document is hosted on a publicly accessible internet address."
}
]
}
},
"wsdlSelector": {
"type": "object",
"description": "Criteria to limit import of WSDL to a subset of the document.",
"properties": {
"wsdlServiceName": {
"type": "string",
"description": "Name of service to import from WSDL"
},
"wsdlEndpointName": {
"type": "string",
"description": "Name of endpoint(port) to import from WSDL"
}
}
},
"apiType": {
"type": "string",
"description": "Type of Api to create. \n * `http` creates a SOAP to REST API \n * `soap` creates a SOAP pass-through API .",
"enum": [
"http",
"soap"
],
"x-ms-client-name": "SoapApiType",
"x-ms-enum": {
"name": "SoapApiType",
"modelAsString": true,
"values": [
{
"value": "http",
"description": "Imports a SOAP API having a RESTful front end.",
"name": "SoapToRest"
},
{
"value": "soap",
"description": "Imports the Soap API having a SOAP front end.",
"name": "SoapPassThrough"
}
]
}
}
},
"allOf": [
{
"$ref": "#/definitions/ApiContractProperties"
}
],
"description": "Api Create or Update Properties."
},
"ApiEntityBaseContract": {
"properties": {
"description": {
"type": "string",
"description": "Description of the API. May include HTML formatting tags."
},
"authenticationSettings": {
"$ref": "#/definitions/AuthenticationSettingsContract",
"description": "Collection of authentication settings included into this API."
},
"subscriptionKeyParameterNames": {
"$ref": "#/definitions/SubscriptionKeyParameterNamesContract",
"description": "Protocols over which API is made available."
},
"type": {
"type": "string",
"description": "Type of API.",
"enum": [
"http",
"soap"
],
"x-ms-client-name": "ApiType",
"x-ms-enum": {
"name": "ApiType",
"modelAsString": true
}
},
"apiRevision": {
"type": "string",
"description": "Describes the Revision of the Api. If no value is provided, default revision 1 is created",
"minLength": 1,
"maxLength": 100
},
"apiVersion": {
"type": "string",
"description": "Indicates the Version identifier of the API if the API is versioned",
"maxLength": 100
},
"isCurrent": {
"type": "boolean",
"description": "Indicates if API revision is current api revision."
},
"isOnline": {
"type": "boolean",
"description": "Indicates if API revision is accessible via the gateway.",
"readOnly": true
},
"apiRevisionDescription": {
"type": "string",
"description": "Description of the Api Revision.",
"maxLength": 256
},
"apiVersionDescription": {
"type": "string",
"description": "Description of the Api Version.",
"maxLength": 256
},
"apiVersionSetId": {
"type": "string",
"description": "A resource identifier for the related ApiVersionSet."
},
"subscriptionRequired": {
"type": "boolean",
"description": "Specifies whether an API or Product subscription is required for accessing the API."
}
},
"description": "API base contract details."
},
"ApiExportResult": {
"properties": {
"id": {
"type": "string",
"description": "ResourceId of the API which was exported."
},
"format": {
"type": "string",
"enum": [
"swagger-link-json",
"wadl-link-json",
"wsdl-link+xml",
"openapi-link"
],
"x-ms-client-name": "ExportResultFormat",
"x-ms-enum": {
"name": "ExportResultFormat",
"modelAsString": true,
"values": [
{
"value": "swagger-link-json",
"description": "The Api Definition is exported in OpenApi Specification 2.0 format to the Storage Blob.",
"name": "Swagger"
},
{
"value": "wsdl-link+xml",
"description": "The Api Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`",
"name": "Wsdl"
},
{
"value": "wadl-link-json",
"description": "Export the Api Definition in WADL Schema to Storage Blob.",
"name": "Wadl"
},
{
"value": "openapi-link",
"description": "Export the Api Definition in OpenApi Specification 3.0 to Storage Blob.",
"name": "OpenApi"
}
]
},
"description": "Format in which the Api Details are exported to the Storage Blob with Sas Key valid for 5 minutes."
},
"value": {
"type": "object",
"description": "The object defining the schema of the exported Api Detail",
"properties": {
"link": {
"type": "string",
"description": "Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes."
}
}
}
},
"description": "API Export result."
},
"ApiReleaseCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiReleaseContract"
},
"description": "Page values.",
"readOnly": true
},
"nextLink": {
"type": "string",
"description": "Next page link if any.",
"readOnly": true
}
},
"description": "Paged ApiRelease list representation."
},
"ApiReleaseContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ApiReleaseContractProperties",
"description": "ApiRelease entity contract properties."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "ApiRelease details."
},
"ApiReleaseContractProperties": {
"properties": {
"apiId": {
"type": "string",
"description": "Identifier of the API the release belongs to."
},
"createdDateTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard."
},
"updatedDateTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The time the API release was updated."
},
"notes": {
"type": "string",
"description": "Release Notes"
}
},
"description": "API Release details"
},
"ApiRevisionCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiRevisionContract"
},
"description": "Page values.",
"readOnly": true
},
"nextLink": {
"type": "string",
"description": "Next page link if any.",
"readOnly": true
}
},
"description": "Paged Api Revision list representation."
},
"ApiRevisionContract": {
"properties": {
"apiId": {
"type": "string",
"readOnly": true,
"description": "Identifier of the API Revision."
},
"apiRevision": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"readOnly": true,
"description": "Revision number of API."
},
"createdDateTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard."
},
"updatedDateTime": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard."
},
"description": {
"type": "string",
"readOnly": true,
"maxLength": 256,
"description": "Description of the API Revision."
},
"privateUrl": {
"type": "string",
"readOnly": true,
"description": "Gateway URL for accessing the non-current API Revision."
},
"isOnline": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if API revision is the current api revision."
},
"isCurrent": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if API revision is accessible via the gateway."
}
},
"description": "Summary of revision metadata."
},
"ApiRevisionInfoContract": {
"description": "Object used to create an API Revision or Version based on an existing API Revision",
"properties": {
"sourceApiId": {
"type": "string",
"description": "Resource identifier of API to be used to create the revision from."
},
"apiVersionName": {
"type": "string",
"maxLength": 100,
"description": "Version identifier for the new API Version."
},
"apiRevisionDescription": {
"type": "string",
"maxLength": 256,
"description": "Description of new API Revision."
},
"apiVersionSet": {
"description": "Version set details",
"$ref": "#/definitions/ApiVersionSetContractDetails"
}
}
},
"ApiTagResourceContractProperties": {
"properties": {
"id": {
"type": "string",
"description": "API identifier in the form /apis/{apiId}."
},
"name": {
"type": "string",
"description": "API name.",
"minLength": 1,
"maxLength": 300
},
"serviceUrl": {
"type": "string",
"description": "Absolute URL of the backend service implementing this API.",
"minLength": 1,
"maxLength": 2000
},
"path": {
"type": "string",
"description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.",
"minLength": 0,
"maxLength": 400
},
"protocols": {
"type": "array",
"items": {
"type": "string",
"enum": [
"http",
"https"
],
"x-ms-enum": {
"name": "Protocol",
"modelAsString": false
}
},
"description": "Describes on which protocols the operations in this API can be invoked."
}
},
"allOf": [
{
"$ref": "./definitions.json#/definitions/ApiEntityBaseContract"
}
],
"description": "API contract properties for the Tag Resources."
},
"ApiUpdateContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ApiContractUpdateProperties",
"description": "Properties of the API entity that can be updated."
}
},
"description": "API update contract details."
},
"ApiContractUpdateProperties": {
"properties": {
"displayName": {
"type": "string",
"description": "API name.",
"minLength": 1,
"maxLength": 300
},
"serviceUrl": {
"type": "string",
"description": "Absolute URL of the backend service implementing this API.",
"minLength": 1,
"maxLength": 2000
},
"path": {
"type": "string",
"description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.",
"minLength": 0,
"maxLength": 400
},
"protocols": {
"type": "array",
"items": {
"type": "string",
"enum": [
"http",
"https"
],
"x-ms-enum": {
"name": "Protocol",
"modelAsString": false
}
},
"description": "Describes on which protocols the operations in this API can be invoked."
}
},
"allOf": [
{
"$ref": "#/definitions/ApiEntityBaseContract"
}
],
"description": "API update contract properties."
},
"ApiVersionSetCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiVersionSetContract"
},
"description": "Page values."
},
"nextLink": {
"type": "string",
"description": "Next page link if any."
}
},
"description": "Paged Api Version Set list representation."
},
"ApiVersionSetContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ApiVersionSetContractProperties",
"description": "Api VersionSet contract properties."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "Api Version Set Contract details."
},
"ApiVersionSetContractDetails": {
"description": "An API Version Set contains the common configuration for a set of API Versions relating ",
"properties": {
"id": {
"type": "string",
"description": "Identifier for existing API Version Set. Omit this value to create a new Version Set."
},
"name": {
"type": "string",
"description": "The display Name of the API Version Set."
},
"description": {
"type": "string",
"description": "Description of API Version Set."
},
"versioningScheme": {
"type": "string",
"description": "An value that determines where the API Version identifier will be located in a HTTP request.",
"enum": [
"Segment",
"Query",
"Header"
]
},
"versionQueryName": {
"type": "string",
"description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`."
},
"versionHeaderName": {
"type": "string",
"description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`."
}
}
},
"ApiVersionSetContractProperties": {
"properties": {
"displayName": {
"type": "string",
"description": "Name of API Version Set",
"minLength": 1,
"maxLength": 100
},
"versioningScheme": {
"type": "string",
"description": "An value that determines where the API Version identifier will be located in a HTTP request.",
"enum": [
"Segment",
"Query",
"Header"
],
"x-ms-enum": {
"name": "versioningScheme",
"modelAsString": true,
"values": [
{
"value": "Segment",
"description": "The API Version is passed in a path segment."
},
{
"value": "Query",
"description": "The API Version is passed in a query parameter."
},
{
"value": "Header",
"description": "The API Version is passed in a HTTP header."
}
]
}
}
},
"allOf": [
{
"$ref": "#/definitions/ApiVersionSetEntityBase"
}
],
"required": [
"displayName",
"versioningScheme"
],
"description": "Properties of an API Version Set."
},
"ApiVersionSetEntityBase": {
"properties": {
"description": {
"type": "string",
"description": "Description of API Version Set."
},
"versionQueryName": {
"type": "string",
"description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`.",
"minLength": 1,
"maxLength": 100
},
"versionHeaderName": {
"type": "string",
"description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.",
"minLength": 1,
"maxLength": 100
}
},
"description": "Api Version set base parameters"
},
"ApiVersionSetUpdateParameters": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ApiVersionSetUpdateParametersProperties",
"description": "Parameters to update or create an Api Version Set Contract."
}
},
"description": "Parameters to update or create an Api Version Set Contract."
},
"ApiVersionSetUpdateParametersProperties": {
"properties": {
"displayName": {
"type": "string",
"description": "Name of API Version Set",
"minLength": 1,
"maxLength": 100
},
"versioningScheme": {
"type": "string",
"description": "An value that determines where the API Version identifier will be located in a HTTP request.",
"enum": [
"Segment",
"Query",
"Header"
],
"x-ms-enum": {
"name": "versioningScheme",
"modelAsString": true,
"values": [
{
"value": "Segment",
"description": "The API Version is passed in a path segment."
},
{
"value": "Query",
"description": "The API Version is passed in a query parameter."
},
{
"value": "Header",
"description": "The API Version is passed in a HTTP header."
}
]
}
}
},
"allOf": [
{
"$ref": "#/definitions/ApiVersionSetEntityBase"
}
],
"description": "Properties used to create or update an API Version Set."
},
"AuthenticationSettingsContract": {
"properties": {
"oAuth2": {
"$ref": "#/definitions/OAuth2AuthenticationSettingsContract",
"description": "OAuth2 Authentication settings"
},
"openid": {
"$ref": "#/definitions/OpenIdAuthenticationSettingsContract",
"description": "OpenID Connect Authentication Settings"
}
},
"description": "API Authentication Settings."
},
"AuthorizationServerCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/AuthorizationServerContract"
},
"description": "Page values."
},
"count": {
"type": "integer",
"format": "int64",
"description": "Total record count number across all pages."
},
"nextLink": {
"type": "string",
"description": "Next page link if any."
}
},
"description": "Paged OAuth2 Authorization Servers list representation."
},
"AuthorizationServerContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/AuthorizationServerContractProperties",
"description": "Properties of the External OAuth authorization server Contract."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "External OAuth authorization server settings."
},
"AuthorizationServerContractBaseProperties": {
"properties": {
"description": {
"type": "string",
"description": "Description of the authorization server. Can contain HTML formatting tags."
},
"authorizationMethods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"HEAD",
"OPTIONS",
"TRACE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"x-ms-enum": {
"name": "AuthorizationMethod",
"modelAsString": false
}
},
"description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional."
},
"clientAuthenticationMethod": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Basic",
"Body"
],
"x-ms-enum": {
"name": "ClientAuthenticationMethod",
"modelAsString": true,
"values": [
{
"value": "Basic",
"description": "Basic Client Authentication method."
},
{
"value": "Body",
"description": "Body based Authentication method."
}
]
}
},
"description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format."
},
"tokenBodyParameters": {
"type": "array",
"items": {
"$ref": "#/definitions/TokenBodyParameterContract"
},
"description": "Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}."
},
"tokenEndpoint": {
"type": "string",
"description": "OAuth token endpoint. Contains absolute URI to entity being referenced.",
"externalDocs": {
"url": "http://tools.ietf.org/html/rfc6749#section-3.1"
}
},
"supportState": {
"type": "boolean",
"description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.",
"externalDocs": {
"url": "http://tools.ietf.org/html/rfc6749#section-3.1"
}
},
"defaultScope": {
"type": "string",
"description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.",
"externalDocs": {
"url": "http://tools.ietf.org/html/rfc6749#section-3.3"
}
},
"bearerTokenSendingMethods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"authorizationHeader",
"query"
],
"x-ms-enum": {
"name": "BearerTokenSendingMethod",
"modelAsString": true
}
},
"description": "Specifies the mechanism by which access token is passed to the API. ",
"externalDocs": {
"url": "http://tools.ietf.org/html/rfc6749#section-4"
}
},
"resourceOwnerUsername": {
"type": "string",
"description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username."
},
"resourceOwnerPassword": {